home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / printing / rsplot11.arc / RSPLOT.MAN < prev    next >
Text File  |  1989-05-08  |  48KB  |  1,222 lines
  1.  
  2.  
  3.     
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                              RSPLOT V1.1 User's Guide
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.                        Copyright (c) 1988, By Bob Silliker
  34.                                All Rights Reserved
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.                        THIS SOFTWARE IS FREEWARE AND IS NOT
  56.                               TO BE SOLD IN ANY FORM
  57.  
  58.  
  59.  
  60.  
  61.     
  62.  
  63.  
  64.     V1.1                       RSPLOT User's Guide                           1
  65.  
  66.  
  67.     1.0 Introduction
  68.  
  69.     Rsplot  is  a general purpose data plotting program that will work in both
  70.     MEDIUM  and  HI  resolution  modes  on  the  ST  series of computers.  The
  71.     program  takes white space separated columns of data stored in ascii files
  72.     and  plots  it under user control.  The user selects which columns of data
  73.     to  plot  and  has  complete  control  over  the  axis scales, marking and
  74.     labelling.   Plots  generated in one resolution can be viewed in the other
  75.     resolution.  
  76.  
  77.     The  program  provides  for  independant  Linear or Log10 axis scaling for
  78.     each  axis.   Linear  scaling can be 1, 2 or 4 quadrants and Log10 scaling
  79.     is 1 quadrant.  
  80.  
  81.     The  program was written primarily for use with output files from the OPUS
  82.     spreadsheet  program that was published in the September 1988 issue of the
  83.     ST  Log  magazine (I have no connection with ST Log magazine except that I
  84.     purchased  a  few  magazines).  However, it can be used with any data file
  85.     that has columns of numerical ascii data.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.     This  manual  was  generated  using  PROFF  V1.0 by Ozan S. Yigit & Steven
  117.     Tress.  
  118.  
  119.  
  120.  
  121.  
  122.     
  123.  
  124.  
  125.     V1.1                       RSPLOT User's Guide                           2
  126.  
  127.  
  128.     2.0 About the program
  129.  
  130.     Version  1.1  has  a  fix  made  to  the parsing of the command line to be
  131.     compatible with Mark Williams Shell.  
  132.  
  133.     Version  1.0 is the first distribution of RSPLOT.  There are no known bugs
  134.     at this time.  
  135.  
  136.  
  137.         2.1 Applications
  138.  
  139.         The  program  supports 10 graphs per application (an application being
  140.         one  RSPLOT  configuration  file).   Each  graph  can contain up to 10
  141.         plots  with  each plot having it's own set of attributes (lines, bars,
  142.         markers  etc).   It  is  possible  to  mix  the types of plots on each
  143.         graph.   The  plot types are lines, lines with markers, markers, group
  144.         bars, stacked bars and overlayed bars.  
  145.  
  146.         The  RSPLOT  configuration  file  has  the  extension  .PLT  and  when
  147.         creating   or   renaming  applications  the  program  will  force  the
  148.         extension,  ignoring anything you put in.  
  149.  
  150.  
  151.         2.2 Axis
  152.  
  153.         Each  graph  has one X axis and two Y (a left and a right).  Each plot
  154.         is  associated with a Y axis.  This makes is possible to view two sets
  155.         of  data that have a common X axis but vary widely in Y values or have
  156.         different units of measure (such as current and temperature).  
  157.  
  158.         Each  axis  can  optionally  have  an  axis  line, axis numbering, tic
  159.         marks,  grid  lines  and  a  label.   Each axis can also have either a
  160.         linear scale or a log10 scale.  
  161.  
  162.  
  163.         2.3 User Lines
  164.  
  165.         Each  graph  has 4 user defined lines associated with each axis.  Each
  166.         line  is  given  an  axis  position  and a string of text that will be
  167.         printed  on  the  line.   The X axis lines are vertical and the Y axis
  168.         lines  are  horizontal.   The  labels  for  the  X  lines  are display
  169.         centered  at  the  top  of  the  line.  The labels for the left Y axis
  170.         lines  are  displayed  over the line on the left of the screen and the
  171.         labels  for  the  right Y axis lines are displyed over the line on the
  172.         right of the screen.  
  173.  
  174.  
  175.         2.4 Data Files
  176.  
  177.         The  user  can  set  up  10 data files per application.  Each file can
  178.         contain  upto  65530 lines of data.  Each line can be a maximum of 640
  179.         characters  or  64 columns.  Anything after either of these two limits
  180.         will  be  ignored.   A  line is defined by anything upto and including
  181.  
  182.  
  183.     
  184.  
  185.  
  186.     V1.1                       RSPLOT User's Guide                           3
  187.  
  188.  
  189.         the  newline  character  (0x0A).  Anything after the newline character
  190.         is  part  of the next line.  The program will ignore any non-printable
  191.         ascii  characters  and  lines  that  do not contain any numbers.  When
  192.         setting  up  a  plot you select the two columns (1 based) that will be
  193.         used  for  X and Y values.  If the X column is 0 then the program will
  194.         generate  it's  own X values.  These values start at X value 1 for the
  195.         first  Y  value  and  increment  by the X value by Y for each Y value.
  196.         This makes it possible to view a single column of data.  
  197.  
  198.  
  199.         2.5 Data Filtering
  200.  
  201.         For  each  plot there are X and Y minimum and maximum setpoint values.
  202.         Initially   these  values  are  set  to  nothing  and  the  filter  is
  203.         disabled.   When legal values are set up and the filter is enabled the
  204.         program  will  check each X and Y value against the appropriate filter
  205.         values  and  will plot points that fall within the setpoints inclusive
  206.         (that  means  if the X setpoints are 10 to 100 and the Y setpoints are
  207.         0  to  1  then points will be plotted where X >= 10 and X <= 100 and Y
  208.         >= 0 and Y <= 1).  
  209.  
  210.  
  211.         2.6 Rotating Data
  212.  
  213.         A  new  feature to the program has been added that allows rotating the
  214.         data  loaded  from  the  data  file  such  that  rows  and columns are
  215.         swapped.   This  provides  a  means  of  viewing  data  by rows.  When
  216.         viewing  a  data,  in  the data window, that has been rotated the file
  217.         rows  are  now  data  columns and file columns are now data rows.  The
  218.         number  of rows and columns that can be rotated this way is limited to
  219.         64  of  either  and  the program will limit this when loading the data
  220.         file.  
  221.  
  222.         If  you  have  a  data file that has more that 64 rows or columns that
  223.         you  want  rotated then you will have to write a conversion utility to
  224.         rotate the data before using it with RSPLOT.  
  225.  
  226.  
  227.         2.7 Memory Usage
  228.  
  229.         All  data for a data file is memory resident and are stored as doubles
  230.         (that's  eight bytes per value).  If you have alot of large data files
  231.         you  may  run  into  memory problems.  There are not many solutions to
  232.         this  problem  at  this  time.   One solution is to try to keeping the
  233.         organization  of  the  data  files  such  that  there  are  no  unused
  234.         columns.   You  can  also try the usual 'remove' all desk accessories'
  235.         trick.   The  only other solution is to break the data file into parts
  236.         and create a separate configuration file for each data file (YUK!).  
  237.  
  238.  
  239.         2.8 Hard Copy
  240.  
  241.         The  program  currently will output graphs into DEGAS compatible files
  242.  
  243.  
  244.     
  245.  
  246.  
  247.     V1.1                       RSPLOT User's Guide                           4
  248.  
  249.  
  250.         or  print  graphs  onto EPSON compatible printers.  The driver used to
  251.         make  hardcopies  is  the same driver that the ALT-HELP sequence uses.
  252.         So  if  you  can  do  screen  dumps with ALT-HELP then you can use the
  253.         Hardcopy  menu entry to print graphs.  If you have access to DEGAS you
  254.         can  use  the  DEGAS  printer  drivers  or  you can design your own by
  255.         obtaining  a copy of the DEGAS printer driver tool kit that Tom Hudson
  256.         wrote  and  which  appeared  in  START  magazine  Spring 1987 Volume 1
  257.         number  4  (I  have  no  connection  with  either  Tom Hudson or START
  258.         magazine, except that I am a, somewhat, satisfied customer).  
  259.  
  260.  
  261.     3.0 Usage
  262.  
  263.     rsplot.ttp [graph-configuration-file-path] 
  264.  
  265.     As  the command line indicates the program takes an opti